de.cebis.moccabox.io.command
Class TaskCommand

java.lang.Object
  de.cebis.moccabox.io.command.Command
      de.cebis.moccabox.io.command.TaskCommand

All Implemented Interfaces:

java.io.Serializable

public class TaskCommand
extends Command
implements java.io.Serializable

Spezialisierung des Command, die den Aufruf eines Vorgangs durch ein IO kapselt. Ein TaskCommand definiert somit den Aufruf eines BusinessTask. Der TaskCommand kapselt sowohl den Befehl als auch dessen Parameter zur Spezifikation des Aufrufes.

Author:

weichelt

See Also:

Serialized Form

Constructor Summary

TaskCommand()
Parameterloser Konstruktor zum Erzeugen eines neuen TaskCommand.

TaskCommand(java.lang.String command)
Konstruktor zum Erzeugen eines neuen TaskCommand.

Method Summary

boolean	getActive() Zurückgeben des Aktivitätsstatus des TaskCommand.
AttributeStore	getAttributeStore() Zurückliefern des Behälters aller Parameter, die den Befehl spezifizieren.
java.lang.String	getDescription() Zurückgeben einer ausführlicheren Beschreibung des TaskCommand.
java.lang.String	getFullName() Zurückliefern des vollen Namens des Befehls inklusive eines eventuell vorhandenen Suffixes, das zur Unterscheidung von Sub-Befehlen verwendet werden kann.
java.lang.String	getImageRepresentation() Zurückgeben eines Bildverweises, durch den der TaskCommand alternativ repräsentiert werden kann.
java.lang.String	getKey() Zurückgeben des Schlüssels, durch den der Befehl referenziert werden kann.
java.lang.String	getSuffix() Zurückliefern des Suffixes, das den Namen des TaskCommand weiter spezialisiert.
boolean	isOpened() Zurückgeben, ob es sich um einen geöffneten oder einen geschlossenen Eintrag handelt.
void	setActive(boolean active) Setzen des Aktivitätsstatus des TaskCommand.
void	setDescription(java.lang.String description) Setzen einer ausführlicheren Beschreibung des TaskCommand.
void	setImageRepresentation(java.lang.String image) Setzen eines Bildverweises, durch den der TaskCommand alternativ repräsentiert werden kann.
void	setKey(java.lang.String key) Setzen des Schlüssels, durch den der Befehl referenziert werden kann.
void	setOpened(boolean newOpened) Setzen, ob der Eintrag geöffnet ist (d.h.
void	setSuffix(java.lang.String suffix) Setzen des Suffixes, das den Namen des TaskCommand weiter spezialisiert.
void	swapState() Falls das Menü geöffnet ist, wird es geschlossen.

Methods inherited from class de.cebis.moccabox.io.command.Command

getCommand, getCommandEvent, getName, setCommand, setCommandEvent, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskCommand

public TaskCommand()

Parameterloser Konstruktor zum Erzeugen eines neuen TaskCommand.

TaskCommand

public TaskCommand(java.lang.String command)

Konstruktor zum Erzeugen eines neuen TaskCommand.

Parameters:

command - Definiert den Befehl, der interpretiert wird, um den entsprechenden Vorgang auszuführen.

Method Detail

getFullName

public java.lang.String getFullName()

Zurückliefern des vollen Namens des Befehls inklusive eines eventuell vorhandenen Suffixes, das zur Unterscheidung von Sub-Befehlen verwendet werden kann. Name und Suffix werden durch einen '.' getrennt.

Returns:

Der volle Name des Befehls. Ist ein Suffix vorhanden, wird dies durch einen '.' vom Namen getrennt. Andernfalls wird der Name zurückgeliefert.

setImageRepresentation

public void setImageRepresentation(java.lang.String image)

Setzen eines Bildverweises, durch den der TaskCommand alternativ repräsentiert werden kann.

Parameters:

image - Referenz auf eine Bildquelle.

getImageRepresentation

public java.lang.String getImageRepresentation()

Zurückgeben eines Bildverweises, durch den der TaskCommand alternativ repräsentiert werden kann.

Returns:

Referenz auf eine Bildquelle.

getDescription

public java.lang.String getDescription()

Zurückgeben einer ausführlicheren Beschreibung des TaskCommand. Diese kann bei der Repräsentation des Befehls als Hinweis- oder Erklärungstext verwendet werden.

Returns:

Beschreibung des Befehls.

setDescription

public void setDescription(java.lang.String description)

Setzen einer ausführlicheren Beschreibung des TaskCommand.

Parameters:

description - Beschreibung des Befehls.

setOpened

public void setOpened(boolean newOpened)

Setzen, ob der Eintrag geöffnet ist (d.h. Untereinträge werden auch angezeigt) oder nicht.

Parameters:

newOpened - True, falls der Eintrag geöffnet ist. False, andernfalls.

isOpened

public boolean isOpened()

Zurückgeben, ob es sich um einen geöffneten oder einen geschlossenen Eintrag handelt.

Returns:

True, falls geöffnet. Andernfalls false.

swapState

public void swapState()

Falls das Menü geöffnet ist, wird es geschlossen. Andernfalls wird es geöffnet.

getActive

public boolean getActive()

Zurückgeben des Aktivitätsstatus des TaskCommand. Ein Befehl, der einen Operator auf einen Konzept oder einem Vorgang repräsentiert, aber vom ausführenden IClient nicht ausgeführt werden darf, kann als inaktiv gesetzt sein. Er ist dann im IO auch als inaktiv zu repräsentieren.

Returns:

True, falls aktiv und ausführbar. False, andernfalls.

setActive

public void setActive(boolean active)

Setzen des Aktivitätsstatus des TaskCommand.

Parameters:

active - True, falls aktiv und ausführbar. False, andernfalls.

getKey

public java.lang.String getKey()

Zurückgeben des Schlüssels, durch den der Befehl referenziert werden kann.

Returns:

Referenzierbarer Schlüssel.

setKey

public void setKey(java.lang.String key)

Setzen des Schlüssels, durch den der Befehl referenziert werden kann.

Parameters:

key - Referenzierbarer Schlüssel.

getSuffix

public java.lang.String getSuffix()

Zurückliefern des Suffixes, das den Namen des TaskCommand weiter spezialisiert.

Returns:

Suffix des Befehls.

setSuffix

public void setSuffix(java.lang.String suffix)

Setzen des Suffixes, das den Namen des TaskCommand weiter spezialisiert.

Parameters:

suffix - Suffix des Befehls.

getAttributeStore

public AttributeStore getAttributeStore()

Zurückliefern des Behälters aller Parameter, die den Befehl spezifizieren.

Returns:

Behälter aller Parameter.